Skip to main content

ARDK for Android/com.nianticlabs.ardk.vps/VPSSession/getAnchorPayload

getAnchorPayload

[androidJvm]
fun getAnchorPayload(uuid: UUID): String?

Gets the payload data of a specified anchor.

The payload encodes the data needed to localize an anchor across multiple devices or sessions. It can be shared or stored for later use with trackAnchor.

Payloads are only available after the anchor is tracked.

Return​

Base64-encoded payload if available, null if otherwise. Payloads are only available after the anchor is tracked.

Parameters​

androidJvm

uuidThe unique identifier of the anchor

See also​

VPSSession.trackAnchor
VPSSession.createAnchor

Throws​

ARDKStatusException with code ARDKStatus.invalidArgument if no anchor with id uuid was found. Check ARDK's C logs for more information.